home *** CD-ROM | disk | FTP | other *** search
/ Gamers Delight 2 / Gamers Delight 2.iso / Aminet / game / role / ZorkMachine.lha / ZorkMachine.doc < prev    next >
Text File  |  1992-05-15  |  8KB  |  150 lines
  1. ============================ Zorkmachine 1.15 =============================
  2. ===========================================================================
  3. `Zorkmachine' is a replacement for Infocom's virtual machine code (ZCode-3)
  4. interpreter.   The  implementation differs from the original implementation
  5. both  in  the  design  of  the  user interface and the number of additional
  6. features  supported.   This  `Zorkmachine'  port requires Kickstart 2.04 or
  7. higher to run.
  8.    Up  to  this  day,  the  interpreter will only run the old-style Infocom
  9. games, such as `The witness', `Hollywood Hijinx' and the like.  Interactive
  10. Fiction  Plus games such as `Trinity' or `A mind forever voyaging' will not
  11. work at all.
  12.  
  13. ================================== Usage ==================================
  14. ===========================================================================
  15. `Zorkmachine'  can  be  started  both  from  Workbench and from Shell.  The
  16. following  options,  which  are both available as calling parameters and as
  17. icon tooltypes, are supported:
  18.  
  19. Protocol....... If using the `script' and `unscript' commands, a transcript
  20.                 of  the story will be sent to a protocol device or protocol
  21.                 file.   By default, this device will be `PRT:', sending the
  22.                 transcript  to  the  printer.   This  output  device can be
  23.                 overridden  by using the `Protocol <Output device or file>'
  24.                 option or from within the program.
  25.  
  26. Width.......... In  order  to  correctly  layout  the  transcript text, the
  27.                 program  has to know how many characters will fit into each
  28.                 single  printer  line.   By  default  the program assumes a
  29.                 value of 80 characters per line.
  30.  
  31. Story.......... The name of the story file to be used for playing.  Infocom
  32.                 usually  assigns  the name `Story.Data' to it which is also
  33.                 the default name `Zorkmachine' will use.
  34.  
  35. Restore........ If  you  wish  to  start  the game using a previously saved
  36.                 game,  use  this option to give the name of the file.  Note
  37.                 that  the  saved  game  file  has to match the story it was
  38.                 saved with.
  39.                    Workbench  users:   in  order  to restore a game, either
  40.                 double-click  on  a  saved game icon or drop the saved game
  41.                 icon to restore into the `Zorkmachine' window.
  42.  
  43. Customscreen... By  default,  `Zorkmachine'  will  open  a  window  on  the
  44.                 Workbench  screen.   If  the  `customscreen'  option  is in
  45.                 effect,  a custom screen will be used.  The screen will use
  46.                 the  same  display modes the same colours and the same font
  47.                 as the Workbench screen.
  48.  
  49. Colour0........ If  using  a  custom screen, these two options will set the
  50. Colour1........ text (colour 1) and the background (colour 0) colours.  The
  51.                 colour values to be used have to be provided in hexadecimal
  52.                 notation  (e.g.   `colour0  000  colour1  ddd'  would  make
  53.                 `Zorkmachine'  use  a  black  background  colour  with grey
  54.                 text).
  55.  
  56. ============================= User interface ==============================
  57. ===========================================================================
  58. Unlike  the  original  Infocom  interpreter,  `Zorkmachine'  supports  line
  59. editing  and  command  history  just  like the AmigaShell does.  If you are
  60. familiar  with the Shell, you will be able to use `Zorkmachine' right away.
  61. Even the cut & paste feature is supported.  Not supported are the ^S and ^Q
  62. key  codes  to  stop  and  restart  terminal  output.
  63.  
  64. Cursor up ................... Go back in history
  65. Cursor down ................. Go forward in history
  66. Cursor left ................. Move cursor one character left
  67. Cursor right ................ Move cursor one character right
  68. CTRL-A, Shift cursor left ... Start of line
  69. CTRL-Z, Shift cursor right .. End of line
  70. CTRL-L ...................... Restore line
  71. CTRL-X ...................... Delete whole line
  72. CTRL-I ...................... Toggle insert/overwrite mode
  73. CTRL-H, Backspace ........... Delete character left of cursor
  74. CTRL-D, Del ................. Delete character under cursor
  75. CTRL-P, Help ................ Program function key F1-F10, shift F1-F10
  76. F1-F10, Shift F1-F10 ........ Recall function key
  77.  
  78.    Pull-down  menus  are  supported  as  well,  most  will simply invoke an
  79. interpreter  function  (such as `time', `score', `brief', etc.).  Only five
  80. menu entries are special:
  81.  
  82. Protocol....... A  requester  will  be  opened  which  allows to select the
  83.                 `script'  output  device/file.   If  scripting  is  already
  84.                 active it will be turned off.  Enter the output file/device
  85.                 and  page width (see options) or click on the `select file'
  86.                 button  which  will  open  a  file  requester to select the
  87.                 output file.
  88.  
  89. Palette........ Just  as  the name says, a requester will be opened to edit
  90.                 the current screen palette.  Note that this menu entry will
  91.                 be  available  only if `Zorkmachine' is running on a custom
  92.                 screen.
  93.  
  94. About.......... Guess and try ;-)
  95.  
  96. Narrate story.. If this switch is active, the text displayed on screen will
  97.                 be spoken by the Amiga speech synthesizer.
  98.  
  99. Debug mode..... This switch has been provided for diagnostic purposes only.
  100.                 Use   it   with   caution  since  the  whole  `Zorkmachine'
  101.                 interpreter run will be displayed on screen.
  102.  
  103.    `Zorkmachine'  will  create  icons with file it saves only if it was run
  104. form Workbench.  If started from Shell, no icons will be created.
  105.  
  106. ============================= The source code =============================
  107. ===========================================================================
  108. I  have  tried  to  remain faithful both to the original code and Infocom's
  109. interpreter program.  It may still prove difficult to recompile the program
  110. code  for  other platforms (Minix, Atari ST, etc.) since the changes I made
  111. may be irreversible.
  112.    A  Makefile  (for  Aztec  `C') and an LMkFile (for Lattice `C' or SAS/C)
  113. have been provided.  Note that Aztec `C' 5.0a or higher and Lattice/SAS `C'
  114. 5.04 or higher are required to recompile the program.
  115.  
  116. ============================ Credits & Authors ============================
  117. ===========================================================================
  118. `Zorkmachine'  was  created by Matthias Pfaller (EMail:  leo@marco.de) from
  119. the  original Z-machine interpreter as running on the Atari ST.  I received
  120. the fragments of an Amiga port created by martin@deepth.ulm.sub.org (I have
  121. failed  to identify the full name of the author) and built this port on it.
  122. Paul  David  Doherty beta-tested this port and suggested a couple of useful
  123. features which can now be found in `Zorkmachine'.
  124.  
  125.          The present keeper of the sources to this Amiga port is:
  126.  
  127.                            Olaf `Olsen' Barthel
  128.                              Brabeckstrasse 35
  129.                             D-3000 Hannover 71
  130.  
  131.                         Federal Republic of Germany
  132.  
  133.                                   Email:
  134.  
  135.                        o.barthel@a-link-h.comlink.de
  136.  
  137. ============================ Revision history =============================
  138. ===========================================================================
  139. 1.15    Script/unscript works again and so does `restore' by dropping icons
  140.         on the `Zorkmachine' window.
  141.  
  142. 1.14    AppWindow  support  works  once  again,  custom  screen and palette
  143.         support  added,  speech  support  reworked, debug mode added, sound
  144.         support  added  (`The  lurking  horror'  finally works!), the input
  145.         routine  converts  all characters entered to lower case in order to
  146.         avoid  trouble  with  the  parser  (which would choke on upper case
  147.         characters).
  148.  
  149. 1.11    First public release.
  150.